Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Database access docs overhaul #5643

Merged
merged 5 commits into from
Feb 27, 2021
Merged

Database access docs overhaul #5643

merged 5 commits into from
Feb 27, 2021

Conversation

r0mant
Copy link
Collaborator

@r0mant r0mant commented Feb 20, 2021

Big overhaul of database access docs. What previously was a single "preview" page, is now split into separate pages under a new top-level section. Below is a brief description of changes.

Database access content hub

The "Database Access" page in the first "Introduction" section will serve as a content hub for database access, with brief description, demo video and links leading to other resources. K8s/app access pages will eventually do the same.

Screen Shot 2021-02-19 at 6 22 00 PM

New top-level section

With the following hierarchy.

Screen Shot 2021-02-19 at 6 19 59 PM

New content

  • Separate guides for Postgres/MySQL self-hosted and on AWS.
  • GUI clients guides for pgAdmin and MySQL Workbench.
  • Separate sections on RBAC and architecture.
  • Configuration and CLI reference.

There's always more content to potentially add but I think this will do for the initial release.

@r0mant r0mant self-assigned this Feb 20, 2021
@r0mant r0mant requested a review from russjones as a code owner February 20, 2021 02:27
@r0mant r0mant changed the base branch from master to branch/v6 February 25, 2021 17:15
@r0mant r0mant force-pushed the roman/dbdocs2 branch 2 times, most recently from cb941cd to 1edc633 Compare February 25, 2021 21:12
@r0mant
Copy link
Collaborator Author

r0mant commented Feb 25, 2021

@benarent Addressed your comments, PTAL.

@r0mant
Copy link
Collaborator Author

r0mant commented Feb 26, 2021

@travelton Addressed your comments, thanks!

--db-uri=db.example.com:3306
```

### Start Database Service with Config File
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for this section. As I was setting up Teleport Application Access we could do something similar for it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, AAP docs are next in line :)

Copy link
Contributor

@benarent benarent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit of beast to review but looks great.

@r0mant
Copy link
Collaborator Author

r0mant commented Feb 27, 2021

@klizhentas Think I've address all of your comments: fb88577 and 987c482 if you want to take a look at the commits.

Copy link
Contributor

@klizhentas klizhentas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@r0mant monumental work. :shipit: 🚀

@r0mant r0mant merged commit 3ed729e into branch/v6 Feb 27, 2021
@r0mant r0mant deleted the roman/dbdocs2 branch February 27, 2021 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants